package de.tuhh.simsearch.webinterface.helper;

/**
 * ResponseObject is used to serialize a boolean value. Success and failure are the strings used to transmit to the
 * client whether an operation was successful. The response object stores the response status and the response
 * description. The response status is either success or failure, the response description can contain a detailed
 * description about the operation (e.g. 'User a is successfully created').
 * 
 * 
 * @author SimSearch 1
 * 
 */
public class ResponseObject {

  /**
   * The string value for success
   */
  public static final String success = "success";

  /**
   * The string value for failure
   */
  public static final String failure = "failure";

  private String responseStatus;
  private String responseDesc;

  /**
   * Gets the response status
   * 
   * @return the response status
   */
  public String getResponseStatus() {

    return responseStatus;
  }

  /**
   * Sets the response status
   * 
   * @param responseStatus
   *          the response status
   */
  public void setResponseStatus(String responseStatus) {

    this.responseStatus = responseStatus;
  }

  /**
   * Gets the response description
   * 
   * @return the response description
   */
  public String getResponseDesc() {

    return responseDesc;
  }

  /**
   * Sets the response description
   * 
   * @param responseDesc
   *          the response description
   */
  public void setResponseDesc(String responseDesc) {

    this.responseDesc = responseDesc;
  }

}
